SftPictureObject.GetColorSample Method
|
|
|
|
|
|
SftPictureObject.GetColorSample Method |
Retrieves the picture object attributes defined as a color sample.
Syntax
|
VB.NET |
object.GetColorSample(ByRef SampleColor As UInteger |
||
|
VB |
object.GetColorSample(SampleColor As OLE_COLOR, FrameColor As OLE_COLOR) |
||
|
C#.NET |
void object.GetColorSample(out uint |
||
|
VC++ |
HRESULT object->GetColorSample(OLE_COLOR* SampleColor, OLE_COLOR* FrameColor); |
||
|
C |
HRESULT object->raw_GetColorSample(OLE_COLOR* SampleColor, OLE_COLOR* FrameColor); |
||
|
Delphi |
procedure object.GetColorSample(out SampleColor : Cardinal, out FrameColor : Cardinal); |
object
A SftPictureObject object.
SampleColor
Returns the current sample color. For information about color properties, please visit the applicable section "Using SftTree/OCX with ...".
FrameColor
Returns the current border color. For information about color properties, please visit the applicable section "Using SftTree/OCX with ...".
Comments
The GetColorSample method retrieves the picture object attributes defined as a color sample.
If the current picture object is not a color sample (SftPictureObject.Type other than sftTypeColorSample), the returned color values are not valid.
The color sample is defined using the SftPictureObject.SampleColor, SftPictureObject.FrameColor, SftPictureObject.Width, SftPictureObject.Height properties or using the SftPictureObject.SetColorSample method.
See Also SftPictureObject Object | Object Hierarchy
